home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / ptrace.0 < prev    next >
Text File  |  1996-09-01  |  13KB  |  216 lines
  1.  
  2. PTRACE(2)                  UNIX Programmer's Manual                  PTRACE(2)
  3.  
  4. NNAAMMEE
  5.      ppttrraaccee - process tracing and debugging
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ppttrraaccee..hh>>
  10.  
  11.      _i_n_t
  12.      ppttrraaccee(_i_n_t _r_e_q_u_e_s_t, _p_i_d___t _p_i_d, _c_a_d_d_r___t _a_d_d_r, _i_n_t _d_a_t_a)
  13.  
  14. DDEESSCCRRIIPPTTIIOONN
  15.      ppttrraaccee() provides tracing and debugging facilities.  It allows one pro-
  16.      cess (the _t_r_a_c_i_n_g process) to control another (the _t_r_a_c_e_d process).  Most
  17.      of the time, the traced process runs normally, but when it receives a
  18.      signal (see sigaction(2)), it stops.  The tracing process is expected to
  19.      notice this via wait(2) or the delivery of a SIGCHLD signal, examine the
  20.      state of the stopped process, and cause it to terminate or continue as
  21.      appropriate.  ppttrraaccee() is the mechanism by which all this happens.
  22.  
  23.      The _r_e_q_u_e_s_t argument specifies what operation is being performed; the
  24.      meaning of the rest of the arguments depends on the operation, but except
  25.      for one special case noted below, all ppttrraaccee() calls are made by the
  26.      tracing process, and the _p_i_d argument specifies the process ID of the
  27.      traced process.  _r_e_q_u_e_s_t can be:
  28.  
  29.      PT_TRACE_ME   This request is the only one used by the traced process; it
  30.                    declares that the process expects to be traced by its par-
  31.                    ent.  All the other arguments are ignored.  (If the parent
  32.                    process does not expect to trace the child, it will proba-
  33.                    bly be rather confused by the results; once the traced pro-
  34.                    cess stops, it cannot be made to continue except via
  35.                    ppttrraaccee().)  When a process has used this request and calls
  36.                    execve(2) or any of the routines built on it (such as
  37.                    execv(3)), it will stop before executing the first instruc-
  38.                    tion of the new image.  Also, any setuid or setgid bits on
  39.                    the executable being executed will be ignored.
  40.  
  41.      PT_READ_I, PT_READ_D
  42.                    These requests read a single int of data from the traced
  43.                    process' address space.  Traditionally, ppttrraaccee() has al-
  44.                    lowed for machines with distinct address spaces for in-
  45.                    struction and data, which is why there are two requests:
  46.                    conceptually, PT_READ_I reads from the instruction space
  47.                    and PT_READ_D reads from the data space.  In the current
  48.                    NetBSD implementation, these two requests are completely
  49.                    identical.  The _a_d_d_r argument specifies the address (in the
  50.                    traced process' virtual address space) at which the read is
  51.                    to be done.  This address does not have to meet any align-
  52.                    ment constraints.  The value read is returned as the return
  53.                    value from ppttrraaccee().
  54.  
  55.      PT_WRITE_I, PT_WRITE_D
  56.                    These requests parallel PT_READ_I and PT_READ_D, except
  57.                    that they write rather than read.  The _d_a_t_a argument sup-
  58.                    plies the value to be written.
  59.  
  60.      PT_READ_U     This request reads an int from the traced process' user
  61.                    structure.  The _a_d_d_r argument specifies the location of the
  62.                    int relative to the base of the user structure; it will
  63.                    usually be an integer value cast to caddr_t either explic-
  64.                    itly or via the presence of a prototype for ppttrraaccee().  Un-
  65.                    like PT_READ_I and PT_READ_D, _a_d_d_r must be aligned on an
  66.                    int boundary.  The value read is returned as the return
  67.                    value from ppttrraaccee().
  68.  
  69.      PT_WRITE_U    This request writes an int into the traced process' user
  70.                    structure.  _a_d_d_r specifies the offset, just as for
  71.                    PT_READ_U, and _d_a_t_a specifies the value to be written, just
  72.                    as for PT_WRITE_I and PT_WRITE_D.
  73.  
  74.      PT_CONTINUE   The traced process continues execution.  _a_d_d_r is an address
  75.                    specifying the place where execution is to be resumed (a
  76.                    new value for the program counter), or (caddr_t)1 to indi-
  77.                    cate that execution is to pick up where it left off.  _d_a_t_a
  78.                    provides a signal number to be delivered to the traced pro-
  79.                    cess as it resumes execution, or 0 if no signal is to be
  80.                    sent.
  81.  
  82.      PT_KILL       The traced process terminates, as if PT_CONTINUE had been
  83.                    used with SIGKILL given as the signal to be delivered.
  84.  
  85.      PT_ATTACH     This request allows a process to gain control of an other-
  86.                    wise unrelated process and begin tracing it.  It does not
  87.                    need any cooperation from the to-be-traced process.  In
  88.                    this case, _p_i_d specifies the process ID of the to-be-traced
  89.                    process, and the other two arguments are ignored.  This re-
  90.                    quest requires that the target process must have the same
  91.                    real UID as the tracing process, and that it must not be
  92.                    executing a setuid or setgid executable.  (If the tracing
  93.                    process is running as root, these restrictions do not ap-
  94.                    ply.)  The tracing process will see the newly-traced pro-
  95.                    cess stop and may then control it as if it had been traced
  96.                    all along.
  97.  
  98.      PT_DETACH     This request is like PT_CONTINUE, except that it does not
  99.                    allow specifying an alternate place to continue execution,
  100.                    and after it succeeds, the traced process is no longer
  101.                    traced and continues execution normally.
  102.  
  103.      Additionally, machine-specific requests can exist.  On the SPARC, these
  104.      are:
  105.  
  106.      PT_GETREGS    This request reads the traced process' machine registers
  107.                    into the ``struct reg'' (defined in <_m_a_c_h_i_n_e_/_r_e_g_._h>) point-
  108.                    ed to by _a_d_d_r.
  109.  
  110.      PT_SETREGS    This request is the converse of PT_GETREGS; it loads the
  111.                    traced process' machine registers from the ``struct reg''
  112.                    (defined in <_m_a_c_h_i_n_e_/_r_e_g_._h>) pointed to by _a_d_d_r.
  113.  
  114.      PT_GETFPREGS  This request reads the traced process' floating-point reg-
  115.                    isters into the ``struct fpreg'' (defined in
  116.                    <_m_a_c_h_i_n_e_/_r_e_g_._h>) pointed to by _a_d_d_r.
  117.  
  118.      PT_SETFPREGS  This request is the converse of PT_GETFPREGS; it loads the
  119.                    traced process' floating-point registers from the ``struct
  120.                    fpreg'' (defined in <_m_a_c_h_i_n_e_/_r_e_g_._h>) pointed to by _a_d_d_r.
  121.  
  122.      PT_SYSCALL    This request is like PT_CONTINUE except that the process
  123.                    will stop next time it executes any system call.  Informa-
  124.                    tion about the system call can be examined with PT_READ_U
  125.                    and potentially modified with PT_WRITE_U through the
  126.                    u_kproc.kp_proc.p_md element of the user structure (see be-
  127.                    low).  If the process is continued with another PT_SYSCALL
  128.                    request, it will stop again on exit from the syscall, at
  129.                    which point the return values can be examined and poten-
  130.                    tially changed.  The u_kproc.kp_proc.p_md element is of
  131.                    type ``struct mdproc'', which should be declared by includ-
  132.                    ing <_s_y_s_/_p_a_r_a_m_._h>, <_s_y_s_/_u_s_e_r_._h>, and <_m_a_c_h_i_n_e_/_p_r_o_c_._h>, and
  133.                    contains the following fields (among others):
  134.                          syscall_num
  135.                          syscall_nargs
  136.                          syscall_args[8]
  137.                          syscall_err
  138.                          syscall_rv[2]
  139.                    When a process stops on entry to a syscall, syscall_num
  140.                    holds the number of the syscall, syscall_nargs holds the
  141.                    number of arguments it expects, and syscall_args holds the
  142.                    arguments themselves.  (Only the first syscall_nargs ele-
  143.                    ments of syscall_args are guaranteed to be useful.)  When a
  144.                    process stops on exit from a syscall, syscall_num is -1,
  145.                    syscall_err holds the error number (see errno(2)), or 0 if
  146.                    no error occurred, and syscall_rv holds the return values.
  147.                    (If the syscall returns only one value, only syscall_rv[0]
  148.                    is useful.)  The tracing process can modify any of these
  149.                    with PT_WRITE_U; only some modifications are useful.
  150.  
  151.                    On entry to a syscall, syscall_num can be changed, and the
  152.                    syscall actually performed will correspond to the new num-
  153.                    ber (it is the responsibility of the tracing process to
  154.                    fill in syscall_args appropriately for the new call, but
  155.                    there is no need to modify syscall_nargs).  If the new
  156.                    syscall number is 0, no syscall is actually performed; in-
  157.                    stead, syscall_err and syscall_rv are passed back to the
  158.                    traced process directly (and therefore should be filled
  159.                    in).  If the syscall number is otherwise out of range, a
  160.                    dummy syscall which simply produces an ENOSYS error is ef-
  161.                    fectively performed.
  162.  
  163.                    On exit from a syscall, only syscall_err and syscall_rv can
  164.                    usefully be changed; they are set to the values returned by
  165.                    the syscall and will be passed back to the traced process
  166.                    by the normal syscall return mechanism.
  167.  
  168. EERRRROORRSS
  169.      Some requests can cause ppttrraaccee() to return -1 as a non-error value; to
  170.      disambiguate, _e_r_r_n_o can be set to 0 before the call and checked after-
  171.      wards.  The possible errors are:
  172.  
  173.      [ESRCH]
  174.            No process having the specified process ID exists.
  175.  
  176.      [EINVAL]
  177.            ++oo   A process attempted to use PT_ATTACH on itself.
  178.            ++oo   The _r_e_q_u_e_s_t was not one of the legal requests.
  179.            ++oo   The _a_d_d_r to PT_READ_U or PT_WRITE_U was not int-aligned.
  180.            ++oo   The signal number (in _d_a_t_a) to PT_CONTINUE or PT_SYSCALL was
  181.                neither 0 nor a legal signal number.
  182.            ++oo   PT_GETREGS, PT_SETREGS, PT_GETFPREGS, or PT_SETFPREGS was at-
  183.                tempted on a process with no valid register set.  (This is nor-
  184.                mally true only of system processes.)
  185.  
  186.      [EBUSY]
  187.            ++oo   PT_ATTACH was attempted on a process that was already being
  188.                traced.
  189.            ++oo   A request attempted to manipulate a process that was being
  190.                traced by some process other than the one making the request.
  191.            ++oo   A request (other than PT_ATTACH) specified a process that
  192.                wasn't stopped.
  193.  
  194.      [EPERM]
  195.            ++oo   A request (other than PT_ATTACH) attempted to manipulate a pro-
  196.  
  197.  
  198.                cess that wasn't being traced at all.
  199.            ++oo   An attempt was made to use PT_ATTACH on a process in violation
  200.                of the requirements listed under PT_ATTACH above.
  201.  
  202. BBUUGGSS
  203.      On the SPARC, the PC is set to the provided PC value for PT_CONTINUE and
  204.      similar calls, but the NPC is set willy-nilly to 4 greater than the PC
  205.      value.  Using PT_GETREGS and PT_SETREGS to modify the PC, passing
  206.      (caddr_t)1 to ppttrraaccee(), should be able to sidestep this.
  207.  
  208.      Single-stepping is not available.
  209.  
  210.      When using PT_SYSCALL, there is no easy way to tell whether the traced
  211.      process stopped because it made a syscall or because a signal was sent at
  212.      a moment that it just happened to have valid-looking garbage in its
  213.      ``struct mdproc''.
  214.  
  215.  NetBSD                        November 7, 1994                              4
  216.